AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Creates a new item, or replaces an old item with a new item. If an item that has the
same primary key as the new item already exists in the specified table, the new item
completely replaces the existing item. You can perform a conditional put operation
(add a new item if one with the specified primary key doesn't exist), or replace an
existing item if it has certain attribute values. You can return the item's attribute
values in the same operation, using the ReturnValues parameter.
When you add an item, the primary key attributes are the only required attributes.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a ValidationException
exception.
To prevent a new item from replacing an existing item, use a conditional expression
that contains the attribute_not_exists function with the name of the attribute
being used as the partition key for the table. Since every record must contain that
attribute, the attribute_not_exists function will only succeed if no matching
item exists.
For more information about PutItem, see Working
with Items in the Amazon DynamoDB Developer Guide.
For .NET Core this operation is only available in asynchronous form. Please refer to PutItemAsync.
Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
public abstract PutItemResponse PutItem( String tableName, Dictionary<String, AttributeValue> item, ReturnValue returnValues )
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the Item map is an AttributeValue object.
Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned. The values returned are strongly consistent. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
| Exception | Condition |
|---|---|
| ConditionalCheckFailedException | A condition specified in the operation could not be evaluated. |
| InternalServerErrorException | An error occurred on the server side. |
| ItemCollectionSizeLimitExceededException | An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. |
| ProvisionedThroughputExceededException | Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide. |
| RequestLimitExceededException | Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase. |
| ResourceNotFoundException | The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE. |
| TransactionConflictException | Operation was rejected because there is an ongoing transaction for the item. |
.NET Framework:
Supported in: 4.5 and newer, 3.5